Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add "Setup auth org ID" action for Enterprise Customers #1979

Merged
merged 1 commit into from
Jan 8, 2024

Conversation

pwnage101
Copy link
Contributor

@pwnage101 pwnage101 commented Jan 4, 2024

ENT-8169

screenshots

Button NOT present when the ENTERPRISE_SSO_ORCHESTRATOR_CONFIGURE_EDX_OAUTH_PATH setting is NOT defined:
Screenshot 2024-01-04 at 16 46 42

Button present when the ENTERPRISE_SSO_ORCHESTRATOR_CONFIGURE_EDX_OAUTH_PATH setting is defined:
Screenshot 2024-01-05 at 13 44 19

Clicking the button leads you to a confirmation page with help text:
Screenshot 2024-01-05 at 13 45 05

Clicking "Setup auth_org_id" results in a success message displayed:
Screenshot 2024-01-05 at 13 45 11

Finally, clicking "Cancel" navigates back to the "Change Enterprise Customer" screen with updated value for the "Auth org id" field.

Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • base.in if needed in production but edx-platform doesn't install it
    • test-master.in if edx-platform pins it, with a matching version
    • make upgrade && make requirements have been run to regenerate requirements
  • make static has been run to update webpack bundling if any static content was updated
  • ./manage.py makemigrations has been run
    • Checkout the Database Migration Confluence page for helpful tips on creating migrations.
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.
    • This should be run from either a venv with all the lms/edx-enterprise requirements installed or if you checked out edx-enterprise into the src directory used by lms, you can run this command through an lms shell.
      • It would be ./manage.py lms makemigrations in the shell.
  • Version bumped
  • Changelog record added
  • Translations updated (see docs/internationalization.rst but also this isn't blocking for merge atm)

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in GitHub Actions, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in edx-platform to upgrade dependencies (including edx-enterprise)
    • This must be done after the version is visible in PyPi as make upgrade in edx-platform will look for the latest version in PyPi.
    • Note: the edx-enterprise constraint in edx-platform must also be bumped to the latest version in PyPi.

@pwnage101 pwnage101 force-pushed the pwnage101/ENT-8169 branch 16 times, most recently from aaec175 to e77729f Compare January 5, 2024 01:08
@pwnage101 pwnage101 marked this pull request as ready for review January 5, 2024 01:09
{{ enterprise_customer|capfirst }}
{% endif %}
›
{% trans "Setup auth org ID" %}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know where to put this translation, do I need to run a make command or something?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can run make extract_translations I think? https://github.com/openedx/edx-platform/blob/2209549e68776f5db3c77a571bba115918fcf3f7/Makefile#L40-L53
That said, you're making changes to an internal tool, so I wouldn't let this be a blocker.

@pwnage101 pwnage101 force-pushed the pwnage101/ENT-8169 branch 4 times, most recently from f7f1575 to 75946f3 Compare January 5, 2024 21:42
@pwnage101
Copy link
Contributor Author

pwnage101 commented Jan 5, 2024

  • Updated text to just match what Joe proposed, with minor alterations.
  • Updated the text "Auth org id" to be consistent across all user-facing text, and matches the pre-existing field display name.
  • Added test coverage and PR screenshots for success message display.

@pwnage101 pwnage101 merged commit 97a5e88 into master Jan 8, 2024
9 checks passed
@pwnage101 pwnage101 deleted the pwnage101/ENT-8169 branch January 8, 2024 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants